feat(share_plus)!: SharePlus refactor #3404

miquelbeltran · 2024-12-18T07:43:56Z

Description

This PR contains several improvements on the share_plus package:

Unified the 3 static methods into a single non-static method.
Access to SharePlus class via instance singleton, rather than using static methods.
Allow to mock SharePlatform for testing.
Consolidated the use of subject and title.
Wrapped all share parameters into the ShareParams class.
Unified native share implementations into a single method (when possible).
Added mailToFallbackEnabled to disable web mailTo failback (enabled by default)
downloadFallbackEnabled is no longer a static setting but part of the ShareParams
Sharing uri is now supported on all platforms by sharing the URI as plain text

Not a breaking change, since the old API is still compatible, only it has been deprecated.
But we should consider bumping the version of share_plus to a major release nevertheless, since the deprecation will break CI/CD lint analysis.

TODO:

Related Issues

Checklist

I read the Contributor Guide and followed the process outlined there for submitting PRs.
I titled the PR using Conventional Commits.
I did not modify the CHANGELOG.md nor the plugin version in pubspec.yaml files.
All existing and new tests are passing.
The analyzer (flutter analyze) does not report any problems on my PR.

Breaking Change

Does your PR require plugin users to manually update their apps to accommodate your change?

Yes, this is a breaking change (please indicate that with a ! in the title as explained in Conventional Commits).
No, this is not a breaking change.

miquelbeltran · 2024-12-19T13:27:50Z

One last big piece missing is the Windows refactor, which I plan to do tomorrow or so.

Then I'll write up a migration guide on the README.md.

The API and functionality is still backwards compatible, but just getting deprecated warnings. The old Share class will be removed eventually.

The subject and title functionality has been consolidated:

title is used everywhere where the value is used in the share sheet as title.
subject is used for email subjects
- on iOS and macOS, to keep compatibility and avoid having a breaking change, it will use the subject if title is not provided, for the share sheet title.

miquelbeltran · 2025-02-20T08:08:53Z

I will review this again later tonight and merge if everything looks ok still

StanleyCocos · 2025-03-17T02:15:23Z

@miquelbeltran
Do you have any plans? This request seems to have been pending for a long time.
Sorry for bothering you.

miquelbeltran · 2025-04-01T11:44:04Z

Hey @StanleyCocos I am very sorry I wanted to have this done during the winter break, and then I got sidetracked. Can I ask you a favor? Could you take a look and give me a review?

Copilot

Pull Request Overview

This PR refactors the share_plus package by unifying sharing methods into a single non-static approach using a singleton instance and the ShareParams class.

Consolidated sharing methods into a single instance method call.
Updated examples and documentation in the README.md to reflect the new API usage.
Added a migration guide for converting from the deprecated static API.

Files not reviewed (19)

packages/share_plus/share_plus/android/src/main/kotlin/dev/fluttercommunity/plus/share/MethodCallHandler.kt: Language not supported
packages/share_plus/share_plus/android/src/main/kotlin/dev/fluttercommunity/plus/share/Share.kt: Language not supported
packages/share_plus/share_plus/example/ios/Runner/AppDelegate.swift: Language not supported
packages/share_plus/share_plus/example/lib/main.dart: Language not supported
packages/share_plus/share_plus/example/windows/flutter/CMakeLists.txt: Language not supported
packages/share_plus/share_plus/example/windows/runner/Runner.rc: Language not supported
packages/share_plus/share_plus/ios/share_plus/Sources/share_plus/FPPSharePlusPlugin.m: Language not supported
packages/share_plus/share_plus/lib/share_plus.dart: Language not supported
packages/share_plus/share_plus/lib/src/share_plus_linux.dart: Language not supported
packages/share_plus/share_plus/lib/src/share_plus_web.dart: Language not supported
packages/share_plus/share_plus/lib/src/share_plus_windows.dart: Language not supported
packages/share_plus/share_plus/macos/share_plus/Sources/share_plus/SharePlusMacosPlugin.swift: Language not supported
packages/share_plus/share_plus/test/share_plus_linux_test.dart: Language not supported
packages/share_plus/share_plus/test/share_plus_test.dart: Language not supported
packages/share_plus/share_plus/test/share_plus_windows_test.dart: Language not supported
packages/share_plus/share_plus/windows/share_plus_plugin.cpp: Language not supported
packages/share_plus/share_plus/windows/share_plus_windows_plugin.h: Language not supported
packages/share_plus/share_plus_platform_interface/lib/method_channel/method_channel_share.dart: Language not supported
packages/share_plus/share_plus_platform_interface/lib/platform_interface/share_plus_platform.dart: Language not supported

packages/share_plus/share_plus/README.md

Co-authored-by: Copilot <[email protected]>

miquelbeltran · 2025-04-04T06:42:29Z

Fixing the analysis errors, and main is merged in as well.

I am going to mark this as a breaking change, although technically it is not, using this package will cause deprecated warnings to appear and the change is big enough that it deserves it.

I am setting myself the goal to merge this by April 18th (two weeks from now). Please, @StanleyCocos and anyone else interested, I'd appreciate a lot to have a review of the changes.

StanleyCocos · 2025-04-07T01:08:56Z

Of course, I’ll try to take a look and offer some suggestions from my side. Things have been quite busy for me recently, but as you mentioned, the merge is in two weeks — I’ll do my best to wrap this up before then. Thanks again!

StanleyCocos · 2025-04-07T02:32:05Z

packages/share_plus/share_plus/lib/share_plus.dart

+      throw ArgumentError(
+        'fileNameOverrides must have the same length as files.',
+      );
+    }



Since Share.downloadFallbackEnabled is a global parameter, we cannot override the functionality already configured by the user. For example, if the user has set Share.downloadFallbackEnabled = false, but the default in ShareParams is true.

StanleyCocos · 2025-04-07T02:35:31Z

...ges/share_plus/share_plus_platform_interface/lib/platform_interface/share_plus_platform.dart

+  /// Cannot be used in combination with [text].
+  ///
+  /// * Supported platforms: iOS, Android
+  ///   Fallsback to sharing the URI as text on other platforms.


Fallsback to Falls back

StanleyCocos · 2025-04-07T02:38:28Z

packages/share_plus/share_plus_platform_interface/lib/method_channel/method_channel_share.dart


-    return ShareResult(result, _statusFromResult(result));
+    return map;
  }

  /// Ensure that a file is readable from the file system. Will create file on-demand under TemporaryDiectory and return the temporary file otherwise.


TemporaryDiectory to TemporaryDirectory

StanleyCocos · 2025-04-07T02:54:34Z

packages/share_plus/share_plus_platform_interface/test/share_plus_platform_interface_test.dart

+          files: [XFile(fd.path)],
+        ),
+      );
+      verify(mockChannel.invokeMethod<String>('share', <String, dynamic>{
        'paths': [fd.path],
        'mimeTypes': ['image/png'],
      }));


I think we can add some mock data for ShareResult. Right now, it seems we only see ShareResult.unavailable.

StanleyCocos · 2025-04-07T04:00:45Z

Can we add some test cases specifically for sharing to ensure the platform-side code works correctly?
https://github.com/fluttercommunity/plus_plugins/blob/main/packages/share_plus/share_plus/example/ios/RunnerTests/RunnerTests.swift

miquelbeltran added 11 commits December 18, 2024 08:42

created new SharePlus public API

63a1c06

file cleanup

cb779d1

implemented Linux

a9fd2fc

windows fallback implementation and documentation

1ebcf0d

update example

bc7d7ba

create constructor, fix linux and windows tests

5952490

implemented web

9294109

implementing the method channel

52ea7ab

remove unnecessary import

d2d38a3

implemented and tested Android

031afbe

fixing comments

c03c6d5

This was referenced Dec 18, 2024

feat(share_plus): Added excludedActivityTypes support for the iOS platform. #3376

Open

feat(share_plus): support rich preview on the share sheet #3372

Open

miquelbeltran added 5 commits December 19, 2024 08:48

add SharePlus public API tests

c67216e

improve deprecated warning

91efda9

refactor ios code

ed77e6d

backwards compatible with subject on iOS

5938996

implemented macos

c595508

miquelbeltran added 2 commits December 20, 2024 10:13

Refactor windows

69f0bad

update documentation

c2bd175

miquelbeltran marked this pull request as ready for review December 20, 2024 09:45

Merge branch 'main' into 3403-share-plus-refactor

476c7ce

miquelbeltran requested a review from vbuberen December 20, 2024 09:45

miquelbeltran changed the title ~~feat(share_plus): SharePlus refactor (WIP)~~ feat(share_plus): SharePlus refactor Dec 20, 2024

miquelbeltran mentioned this pull request Dec 20, 2024

[share]: make Share an instantiable object #2818

Open

fix format

869e03b

miquelbeltran mentioned this pull request Jan 14, 2025

[Bug]: shareXFiles with XFile.fromData fails on Windows #3432

Open

8 tasks

miquelbeltran mentioned this pull request Jan 18, 2025

feat(share_plus): Add the intent options for the Android platform #3435

Closed

7 tasks

Merge branch 'main' into 3403-share-plus-refactor

d0504d2

Merge branch 'main' into 3403-share-plus-refactor

e7ef5f2

miquelbeltran self-assigned this Apr 1, 2025

miquelbeltran requested a review from Copilot April 1, 2025 11:44

Copilot AI reviewed Apr 1, 2025

View reviewed changes

packages/share_plus/share_plus/README.md Outdated Show resolved Hide resolved

miquelbeltran and others added 2 commits April 1, 2025 13:46

Update packages/share_plus/share_plus/README.md

f5ab0eb

Co-authored-by: Copilot <[email protected]>

fix analysis in integration test

bad0154

miquelbeltran changed the title ~~feat(share_plus): SharePlus refactor~~ feat(share_plus)!: SharePlus refactor Apr 4, 2025

StanleyCocos reviewed Apr 7, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(share_plus)!: SharePlus refactor #3404

feat(share_plus)!: SharePlus refactor #3404

miquelbeltran commented Dec 18, 2024 •

edited

Loading

miquelbeltran commented Dec 19, 2024

miquelbeltran commented Feb 20, 2025

StanleyCocos commented Mar 17, 2025

miquelbeltran commented Apr 1, 2025

Copilot AI left a comment

miquelbeltran commented Apr 4, 2025

StanleyCocos commented Apr 7, 2025

StanleyCocos Apr 7, 2025

StanleyCocos Apr 7, 2025

StanleyCocos Apr 7, 2025

StanleyCocos Apr 7, 2025

StanleyCocos commented Apr 7, 2025

feat(share_plus)!: SharePlus refactor #3404

Are you sure you want to change the base?

feat(share_plus)!: SharePlus refactor #3404

Conversation

miquelbeltran commented Dec 18, 2024 • edited Loading

Description

TODO:

Related Issues

Checklist

Breaking Change

miquelbeltran commented Dec 19, 2024

miquelbeltran commented Feb 20, 2025

StanleyCocos commented Mar 17, 2025

miquelbeltran commented Apr 1, 2025

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

miquelbeltran commented Apr 4, 2025

StanleyCocos commented Apr 7, 2025

StanleyCocos Apr 7, 2025

Choose a reason for hiding this comment

StanleyCocos Apr 7, 2025

Choose a reason for hiding this comment

StanleyCocos Apr 7, 2025

Choose a reason for hiding this comment

StanleyCocos Apr 7, 2025

Choose a reason for hiding this comment

StanleyCocos commented Apr 7, 2025

miquelbeltran commented Dec 18, 2024 •

edited

Loading